GET api/units/{unitId}/archmods?status[0]={status[0]}&status[1]={status[1]}&sort={sort}&page={page}&pageSize={pageSize}

Get all arch mods for a unit

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
unitId	(Required)	integer	Required
status	Limits the results by module status ids. See the GET api/modulestatuses/archmods route to retrieve all arch mods statuses.	Collection of integer	None.
sort	(Optional)The order in which to sort the returned architectural modifications. Defaults to createdon descending. The possible values are: createdon	string
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfArchMod

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of ArchMod	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "ArchModId": 1,
      "PropertyId": 2,
      "UnitId": 1,
      "Description": "sample string 3",
      "ResidentId": 1,
      "ModuleProgressCodeId": 1,
      "ReviewFee": "sample string 4",
      "NonRefundableDeposit": "sample string 5",
      "RefundableDeposit": "sample string 6",
      "DateReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateReviewFeeReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateNonRefundableDepositReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateRefundableDepositReceived": "2025-12-24T05:27:29.8466229-05:00",
      "StartDate": "2025-12-24T05:27:29.8466229-05:00",
      "EndDate": "2025-12-24T05:27:29.8466229-05:00",
      "ModuleStatusId": 7,
      "Notes": "sample string 8",
      "Categories": [
        1,
        2
      ]
    },
    {
      "ArchModId": 1,
      "PropertyId": 2,
      "UnitId": 1,
      "Description": "sample string 3",
      "ResidentId": 1,
      "ModuleProgressCodeId": 1,
      "ReviewFee": "sample string 4",
      "NonRefundableDeposit": "sample string 5",
      "RefundableDeposit": "sample string 6",
      "DateReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateReviewFeeReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateNonRefundableDepositReceived": "2025-12-24T05:27:29.8466229-05:00",
      "DateRefundableDepositReceived": "2025-12-24T05:27:29.8466229-05:00",
      "StartDate": "2025-12-24T05:27:29.8466229-05:00",
      "EndDate": "2025-12-24T05:27:29.8466229-05:00",
      "ModuleStatusId": 7,
      "Notes": "sample string 8",
      "Categories": [
        1,
        2
      ]
    }
  ]
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)